Main Page | Class Hierarchy | Class List | Class Members

BustaNetMsgQ Class Reference

Network Message Queue. More...

#include <BustaNetMsgQ.h>

List of all members.

Public Member Functions

 BustaNetMsgQ ()
 CONSTRUCTOR.
 ~BustaNetMsgQ ()
 DESTRUCTOR.
BustaNetInternalMsgpop ()
 Pop from the front of the queue.
void enqueue (BustaNetInternalMsg *newMsg)
 Adds a new message to the queue.
void flushQ ()
 Empties the Queue.
int getNodeCount ()
 Returns the count of messages in the queue.
bool isEmpty ()
 Returns whether or not the queue is empty.


Detailed Description

Network Message Queue.

This is a linked list implementation of a message queue. The queue is provided by the client to the engine such that multiple server messages or special sandwiches can be sent before the engine addresses the messages.


Constructor & Destructor Documentation

BustaNetMsgQ::BustaNetMsgQ  ) 
 

CONSTRUCTOR.

Creates an empty message queue.

BustaNetMsgQ::~BustaNetMsgQ  ) 
 

DESTRUCTOR.

Empties queue and frees memory.


Member Function Documentation

void BustaNetMsgQ::enqueue BustaNetInternalMsg newMsg  ) 
 

Adds a new message to the queue.

Adds a preconstructed network message to the end of the message queue.

Parameters:
newNsg The new message to be added to the queue

void BustaNetMsgQ::flushQ  ) 
 

Empties the Queue.

The message queue is emptied of all messages. All messages are deleted from memory.

int BustaNetMsgQ::getNodeCount  ) 
 

Returns the count of messages in the queue.

Returns the count of messages currently in the message queue

bool BustaNetMsgQ::isEmpty  ) 
 

Returns whether or not the queue is empty.

Returns if the queue is empty of messages.

Returns:
Returns true if the queue is empty and false otherwise

BustaNetInternalMsg * BustaNetMsgQ::pop  ) 
 

Pop from the front of the queue.

Returns a pointer to the first message in the queue. The message must be deleted after use!

Returns:
A pointer to the first message in the queue. Returns null if the queue is empty.


Generated on Sun Aug 14 22:24:57 2005 for BustaSandwich Networking by  doxygen 1.4.2-20050421